docs: readthedocs build fix - #77
Conversation
Adds the missing sphinx-prompt dependency to the build process. This dependency is part of the 'dev' dependency group, however, it is currently not possible to install dependency groups to the system site-package (either with pip or uv). Signed-off-by: Liam Brady <lbrady@labn.net>
liambrady
added
bug
| @@ -8,5 +8,7 @@ build: | |||
| # - pip install uv | |||
There was a problem hiding this comment.
Isn't this running in the munet workspace? Can we just use uv to install things?
Although, this is for producing the docs right? If it's not actually running munet, I'm not sure why we need to install munet at all.
There was a problem hiding this comment.
This is for producing the docs, correct.
Based on my limited understanding, uv does not support installing dependency groups into the workspaces using 'uv pip install', since they mirror the 'pip install' CLI. Maybe with the exception of the very latest versions of pip, you cannot requirements listed in dependency groups (e.g. 'dev' or 'ide' in the pyproject.yaml), so it is similarly not possible with uv.
Instead, you need to use something like 'uv sync --dev', which will install them to whatever workspace that uv has created.
Since it doesn't look like we are using the uv workspace (or uv at all, since you commented it out), I figured it is just simpler to install the dependency ourselves and move on.
There was a problem hiding this comment.
Although, this is for producing the docs right? If it's not actually running munet, I'm not sure why we need to install munet at all.
Agreed, we might be able to get away with just installing sphinx and sphinx-prompt. Should I test that and update the readthedocs.yml file if it is successful?
There was a problem hiding this comment.
Looks like the munet docstrings are referenced in order to build the API doc pages. They appear to pull from the installed munet version, so we can't get away with skipping the munet install.
2 participants
Adds the missing sphinx-prompt dependency to the build process. This dependency is part of the 'dev' dependency group, however, it is currently not possible to install dependency groups to the system site-package (either with pip or uv).
link to the built documentation with this fix: https://munet.readthedocs.io/en/liambrady-docs_fix_2/
closes #76